<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dppsu: xdppsu_edid.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dppsu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdppsu__edid_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdppsu_edid.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains functions related to accessing the Extended Display Identification Data (EDID) of a specified sink using the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> driver. </p>
<dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   aad  27/01/17 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abd0fa16cc316a99a72bab32753d48cd3"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdppsu__edid_8c.html#abd0fa16cc316a99a72bab32753d48cd3">XDpPsu_GetEdid</a> (<a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *InstancePtr, u8 *Edid)</td></tr>
<tr class="memdesc:abd0fa16cc316a99a72bab32753d48cd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function retrieves an immediately connected RX device's Extended Display Identification Data (EDID) structure.  <a href="#abd0fa16cc316a99a72bab32753d48cd3">More...</a><br/></td></tr>
<tr class="separator:abd0fa16cc316a99a72bab32753d48cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cfcf97f7f82b214ea57ba6ea2564914"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdppsu__edid_8c.html#a1cfcf97f7f82b214ea57ba6ea2564914">XDpPsu_GetEdidBlock</a> (<a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *InstancePtr, u8 *Data, u8 BlockNum)</td></tr>
<tr class="memdesc:a1cfcf97f7f82b214ea57ba6ea2564914"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve an immediately connected RX device's Extended Display Identification Data (EDID) block given the block number.  <a href="#a1cfcf97f7f82b214ea57ba6ea2564914">More...</a><br/></td></tr>
<tr class="separator:a1cfcf97f7f82b214ea57ba6ea2564914"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac915592ad26d01d7dca7c150bd985ee0"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdppsu__edid_8c.html#ac915592ad26d01d7dca7c150bd985ee0">XDpPsu_GetDispIdDataBlock</a> (u8 *DisplayIdRaw, u8 SectionTag, u8 **DataBlockPtr)</td></tr>
<tr class="memdesc:ac915592ad26d01d7dca7c150bd985ee0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given a section tag, search for and retrieve the appropriate section data block that is part of the specified DisplayID structure.  <a href="#ac915592ad26d01d7dca7c150bd985ee0">More...</a><br/></td></tr>
<tr class="separator:ac915592ad26d01d7dca7c150bd985ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac915592ad26d01d7dca7c150bd985ee0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDpPsu_GetDispIdDataBlock </td>
          <td>(</td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>DisplayIdRaw</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>SectionTag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 **&#160;</td>
          <td class="paramname"><em>DataBlockPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Given a section tag, search for and retrieve the appropriate section data block that is part of the specified DisplayID structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DisplayIdRaw</td><td>is a pointer to the DisplayID data. </td></tr>
    <tr><td class="paramname">SectionTag</td><td>is the tag to search for that represents the desired section data block. </td></tr>
    <tr><td class="paramname">DataBlockPtr</td><td>will be set by this function to point to the appropriate section data block that is part of the DisplayIdRaw.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the section data block with the specified tag was found.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The DataBlockPtr argument is modified to point to the entry in DisplayIdRaw that represents the beginning of the desired section data block. </dd></dl>

</div>
</div>
<a class="anchor" id="abd0fa16cc316a99a72bab32753d48cd3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDpPsu_GetEdid </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>Edid</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function retrieves an immediately connected RX device's Extended Display Identification Data (EDID) structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> instance. </td></tr>
    <tr><td class="paramname">Edid</td><td>is a pointer to the Edid buffer to save to.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the I2C transactions to read the EDID were successful.</li>
<li>XST_ERROR_COUNT_MAX if the EDID read request timed out.</li>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dp_psu.html#a1a3729a9b372f0371dea0a523cdf639d">XDpPsu::IsReady</a>, and <a class="el" href="xdppsu_8h.html#a1cfcf97f7f82b214ea57ba6ea2564914">XDpPsu_GetEdidBlock()</a>.</p>

</div>
</div>
<a class="anchor" id="a1cfcf97f7f82b214ea57ba6ea2564914"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDpPsu_GetEdidBlock </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>Data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>BlockNum</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve an immediately connected RX device's Extended Display Identification Data (EDID) block given the block number. </p>
<p>A block number of 0 represents the base EDID and subsequent block numbers represent EDID extension blocks.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> instance. </td></tr>
    <tr><td class="paramname">Data</td><td>is a pointer to the data buffer to save the block data to. </td></tr>
    <tr><td class="paramname">BlockNum</td><td>is the EDID block number to retrieve.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the block read has successfully completed with no errors.</li>
<li>XST_ERROR_COUNT_MAX if a time out occurred while attempting to read the requested block.</li>
<li>XST_DEVICE_NOT_FOUND if no RX device is connected.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdppsu_8c.html#a17608072027dcae9a885b07ad2c25690">XDpPsu_IicRead()</a>.</p>

<p>Referenced by <a class="el" href="xdppsu__edid_8c.html#abd0fa16cc316a99a72bab32753d48cd3">XDpPsu_GetEdid()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
